ComponentBase Class Reference
[VST Implementation Helper Classes]

Base class for VST 3 Component and Edit Controller. More...

#include <vstcomponentbase.h>

Inheritance diagram for ComponentBase:
Inheritance graph
[legend]

Public Member Functions

 ComponentBase ()
virtual ~ComponentBase ()
FUnknowngetHostContext ()
 Returns the hostContext (set by the host during initialize call).
IConnectionPointgetPeer ()
 Returns the peer for the messaging communication (you can only use IConnectionPoint::notify for communicate between peers, do not try to cast peerConnection.
IMessageallocateMessage ()
 Allocates a message instance (don't forget to release it).
tresult sendMessage (IMessage *message)
 Sends the given message to the peer.
tresult sendTextMessage (const char8 *text)
 Sends a simple text message to the peer (max 255 characters).
virtual tresult receiveText (const char8 *text)
 Receives a simple text message from the peer (max 255 characters).
virtual tresult initialize (FUnknown *context)
virtual tresult terminate ()
tresult connect (IConnectionPoint *other)
tresult disconnect (IConnectionPoint *other)
tresult notify (IMessage *message)

Data Fields

OBJ_METHODS(ComponentBase,
FObject) DEFINE_INTERFACES
DEF_INTERFACE(IPluginBase)
DEF_INTERFACE(IConnectionPoint)
END_DEFINE_INTERFACES(FObject)
REFCOUNT_METHODS(FObject)
protected IConnectionPoint
peerConnection

Detailed Description

Base class for VST 3 Component and Edit Controller.


Constructor & Destructor Documentation

ComponentBase (  ) 
~ComponentBase (  )  [virtual]

Member Function Documentation

FUnknown* getHostContext (  )  [inline]

Returns the hostContext (set by the host during initialize call).

IConnectionPoint* getPeer (  )  [inline]

Returns the peer for the messaging communication (you can only use IConnectionPoint::notify for communicate between peers, do not try to cast peerConnection.

IMessage * allocateMessage (  ) 

Allocates a message instance (don't forget to release it).

tresult sendMessage ( IMessage message  ) 

Sends the given message to the peer.

tresult sendTextMessage ( const char8 text  ) 

Sends a simple text message to the peer (max 255 characters).

tresult receiveText ( const char8 text  )  [virtual]

Receives a simple text message from the peer (max 255 characters).

tresult initialize ( FUnknown context  )  [virtual]

Implements IPluginBase.

Reimplemented in Component, EditController, and SingleComponentEffect.

tresult terminate (  )  [virtual]

Implements IPluginBase.

Reimplemented in Component, EditController, and SingleComponentEffect.

tresult connect ( IConnectionPoint other  ) 
tresult disconnect ( IConnectionPoint other  ) 
tresult notify ( IMessage message  )  [virtual]

Implements IConnectionPoint.


Field Documentation

OBJ_METHODS (ComponentBase, FObject) DEFINE_INTERFACES DEF_INTERFACE (IPluginBase) DEF_INTERFACE (IConnectionPoint) END_DEFINE_INTERFACES (FObject) REFCOUNT_METHODS(FObject) protected IConnectionPoint* peerConnection
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.